Reviewer's Guide

Makes upstream PR filename-to-rule matching case-insensitive and normalizes matched rule components to lowercase so tests are correctly collected when using the --upstream-pr option.

Sequence diagram for pytest collection with upstream-pr case-insensitive matching

sequenceDiagram
    actor Developer
    participant Pytest as PytestRunner
    participant UpstreamPR as UpstreamPROptionHandler
    participant RuleSet as RuleSet
    participant Matcher as match_file_to_rule
    participant Components as ComponentSet

    Developer->>Pytest: run pytest --upstream-pr foreman/PR_ID
    Pytest->>UpstreamPR: parse --upstream-pr option
    UpstreamPR->>RuleSet: load rules from ROBOTTELO_GITHUB_REPOS__FOREMAN__RULES
    Pytest->>UpstreamPR: pytest_collection_modifyitems(session, items, config)

    loop for each filename in upstream PR
        UpstreamPR->>RuleSet: iterate over rules
        loop for each rule
            UpstreamPR->>Matcher: match_file_to_rule(filename, rule)
            Matcher->>Matcher: re.search(rule.path, filename, IGNORECASE)
            Matcher-->>UpstreamPR: True or False
            alt filename matches rule
                UpstreamPR->>Components: components.add(rule.component.lower())
                UpstreamPR->>UpstreamPR: mark filename as processed
            end
        end
    end

    UpstreamPR-->>Pytest: components associated with items
    Pytest-->>Developer: collected tests filtered by components

Class diagram for upstream_pr matching and collection helpers

classDiagram
    class Rule {
        +str path
        +str component
    }

    class UpstreamPROptionHandler {
        +pytest_collection_modifyitems(session, items, config)
        -set components
        -set unprocessed_filenames
        -set matched_filenames
    }

    class Matcher {
        +match_file_to_rule(filename, rule) bool
    }

    class ComponentSet {
        +add(component)
        +__contains__(component) bool
    }

    UpstreamPROptionHandler --> Rule : uses
    UpstreamPROptionHandler --> Matcher : calls
    UpstreamPROptionHandler --> ComponentSet : stores components
    Matcher --> Rule : reads path and component

File-Level Changes

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.